Skip to content


tag  jupyter  tips  ai  deep learning  beginner  regression  reinforcement learning  q learning  gym  gymnasium  ardupilot  None  ros2  dds  micro ros  xrce  sitl  plugin  SITL  debug  rangefinder  pymavlink  mavros  gazebo  distance sensor  system_time  timesync  cmake  gtest  ctest  101  cpp  c++  format  fmt  multithreading  spdlog  cyclonedds  eprosima  fastdds  simulation  config  ignition  bridge  sdf  ign-transport  camera  sensors  lidar  aptly  apt  repository  repo  local  mirror  encryption  pgp  docker  container  state  networking  network  nvidia  python  app  devcontainer  gui  tutorial  volume  mount  compose  multi-stage  stage  docker compose  git  bundle  submodules  github  hooks  pre-commit  lxd  lxc  x11  profile  vscode  marpit  presentation  marp  markdown  mermaid  mkdocs  video  ffmpeg  gstreamer  cheat-sheet  sdp  v4l2loopback  gi  kml  geo  gis  spatial  gdal  ogr  raster  vector  snippets  cheat Sheet  asyncio  future  click  cli  cupy  numpy  gpu  dev container  deb  debian  package  setup  stdeb  project  hydra  yaml  configuration  matplotlib  3d  subplot  template  black  isort  templates  cookiecutter  docs  project document  docstrings  flake8  linter  git-hook  mypy  unittest  pytest  pylint  from a-z  fixture  scope  logging  pytest.ini  mock  enum  flag  iterator  generator  yml  logging config  tuple  namedtuple  typing  annotation  generic  literal  protocol  self  typed dict  typevar  pyzmq  zmq  msgpack  action  namespace  remap  control2  ros2_control  effort  velocity  gdb  qos  plugins  msg  node  zero-copy  shm  algorithm  calibration  diff  pid  dev  colcon  colcon_cd  settings  behavior  py_trees  bt  behavior_trees  blackboard  plot  visualization  debugging  diagnostic  DiagnosticTask  diagnostics  tutorials  gst  math  apm  rat_runtime_monitor  bag  rosbag  rosbags  tools  ros  web  rosbridge  vue  binding  discovery  gazebo-classic  launch  spawn  model  cook  gps  imu  ray  gazebo_ros_ray_sensor  ultrsonic  range  ultrasonic  gazebo classic  wrench  odom  garden  gz  ign  xacro  ros_ign  diff_drive  odometry  joint_state  argument  OpaqueFunction  DeclareLaunchArgument  LaunchConfiguration  tmux  nav  slam  test  rclpy  goal abort  cancel goal  action client  action server  custom messages  executor  MultiThreadedExecutor  SingleThreadedExecutor  param  dynamic-reconfigure  service  client  setup.py  package.xml  parameter  parameters  custom  msgs  executers  pub  sub  rqt  rviz  rviz2  pose  marker  tf2  local_setup  rosdep  package manager  project settings  vcstool  urdf  robot_state_publisher  urdf_to_graphiz  joint  link  zenoh  tags  hands on  webinar  cross-compiler  nano  rpi  texture  joints  tmuxp  loop device  rootfs  embedded  zah  linux  rm  ubuntu  sudo  sudoers  nopasswd  visudo  udev  key  gpg  sign  commands  update-alternative  dpkg  ip  ss  netstat  snap  deploy  ssh  systemd  socat  serial  udp  tc  mtu  select  robotics  path planning  trajectory  speed  kalman_filter  kalman  filter  control  code  extensions  json  schema  yocto  poky  qemu  projects  courses to follow  matrix  graphics  rotation  2d  drone  quad  uav  design  vrx  buoyancy 

yaml json files and json-schema

#json   #yaml   #json   #schema   #vscode  

Table of Content

VSCode has the ability to display autocomplete suggestions for JSON and YAML format out of the box.
It’s use JSON schema to do it

JSON Schema#

JSON Schema is a specification that allows you to describe the structure of a JSON document and validate documents against that schema.

VSCode manage json schema by set json.schemas in settings.json

settings.json
"json.schemas": [
      {
          "fileMatch": [
              "demo.json"
          ],
          "url": "file:<path>/demo.schema.json"
      }
]
demo.json
{
    "ip": "127.0.0.1",
    "port": 2000
}
demo.schema.json
{
    "type": "object",
    "properties": {
        "ip": {
            "type": "string"
        },
        "port": {
            "type": "integer",
            "maximum": 10000,
            "minimum": 1024
        }
    },
    "required": [
        "ip",
        "port"
    ]
}

online json schema creator

json schema creator

Demos#

  • More schema options
  • array
  • enum
  • dependentRequired
  • anyOf
  • If-Then-Else
array
"protocol": {
      "type":"array",
      "items": {
          "type": "string",
          "enum": ["tcp", "udp"]
      },
      "minItems": 2,
      "uniqueItems": true
  }
enum
"protocol": {
    "type":"string",
    "enum": ["tcp", "udp"]
}
dependentRequired
{
    "type": "object",
    "properties": {
        "ip": {
            "type": "string"
        },
        "port": {
            "type": "integer",
            "maximum": 10000,
            "minimum": 1024
        },
        "advance": {
            "type":"boolean"
        }


    },
    "required": [
        "ip"

    ],
    "dependentRequired": {
        "advance": ["port"]
    }
}

anyOf#

schema reference - data property can be: - string with max two char - positive numbers

anyOf
{
    "type": "object",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "string",
                    "maxLength": 2
                },
                {
                    "type": "number",
                    "minimum": 0
                }
            ]
        }
    }
}

YAML and json schema#

Using YAML red hat we can config yaml file to validate against json schema

settings#

"yaml.schemas": {
  "<shema file location>.json": "<file useage by schema>.yaml",
},

Demo#

  • Simple schema withou

References#